home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 January: Mac OS SDK / Dev.CD Jan 97 SDK2.toast / Development Kits (Disc 2) / OpenDoc Development Framework / ODF-Interest Archive / June 96 / Documentation Suggestion < prev    next >
Encoding:
Internet Message Format  |  1996-12-03  |  1.2 KB  |  [TEXT/ttxt]
  1. Subject:     Documentation Suggestion
  2. Sent:        6/20/96 2:59 PM
  3. Received:    6/24/96 8:26 AM
  4. From:        Hutchings Software Development, hsd@earthlink.net
  5. Reply-To:    ODF Interest, ODF-Interest@CILabs.ORG
  6. To:          OpenDoc Development Framework Discussion List, ODF-Interest@CILabs.
  7.  
  8. Hi,
  9.  
  10. I've done battle with offscreen drawing again, and have a
  11. documentation suggestion.
  12.  
  13. For classes that wrap platform behavior, data structures, and/or API
  14. calls, it would be helpful if ODF Assistant had annotations for which
  15. parameters get passed through to which platform calls, and if (on the
  16. Mac) there were links to MTBA pages.
  17.  
  18. Example: FW_CBitmap constructor
  19.  
  20.     FW_CBitmap(    short width,
  21.                 short height,
  22.                 short pixelSize,
  23.                 FW_Palette palette = NULL);
  24.  
  25. Since pixelSize is eventually passed to ::NewGWorld(), it would be
  26. useful to have a link to ::NewGWorld(). If I'd had that, I'd have
  27. quickly been reminded that "0" is usually the right value to pass.
  28.  
  29. Instead, I fired up MacBrowse for ODF to dig through the code. That
  30. approach works fine, but takes a little more time.
  31.  
  32. Brad
  33.  
  34.  
  35.  
  36. Richard B. "Brad" Hutchings
  37. General Partner,
  38. Hutchings Software Development
  39.  
  40. hsd@earthlink.net
  41.  
  42.  
  43.